home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpdisplay.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  3.5 KB  |  112 lines
  1. <refentry id="libgimp-gimpdisplay" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpdisplay</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpdisplay</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gint32">gint32</link>      <link linkend="gimp-display-new">gimp_display_new</link>                (<link linkend="gint32">gint32</link> image_ID);
  18. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-display-delete">gimp_display_delete</link>             (<link linkend="gint32">gint32</link> display_ID);
  19. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-displays-flush">gimp_displays_flush</link>             (void);
  20. </synopsis>
  21. </refsynopsisdiv>
  22.  
  23.  
  24.  
  25.  
  26.  
  27. <refsect1>
  28. <title>Description</title>
  29. <para>
  30.  
  31. </para>
  32. </refsect1>
  33.  
  34. <refsect1>
  35. <title>Details</title>
  36. <refsect2>
  37. <title><anchor id="gimp-display-new">gimp_display_new ()</title>
  38. <programlisting><link linkend="gint32">gint32</link>      gimp_display_new                (<link linkend="gint32">gint32</link> image_ID);</programlisting>
  39. <para>
  40. Create a new display for the specified image.
  41. </para>
  42. <para>
  43. Creates a new display for the specified image. If the image already
  44. has a display, another is added. Multiple displays are handled
  45. transparently by the GIMP. The newly created display is returned and
  46. can be subsequently destroyed with a call to 'gimp-display-delete'.
  47. This procedure only makes sense for use with the GIMP UI.</para>
  48. <para>
  49.  
  50. </para><informaltable pgwide=1 frame="none" role="params">
  51. <tgroup cols="2">
  52. <colspec colwidth="2*">
  53. <colspec colwidth="8*">
  54. <tbody>
  55. <row><entry align="right"><parameter>image_ID</parameter> :</entry>
  56. <entry> The image.
  57. </entry></row>
  58. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The new display.
  59. </entry></row>
  60. </tbody></tgroup></informaltable></refsect2>
  61. <refsect2>
  62. <title><anchor id="gimp-display-delete">gimp_display_delete ()</title>
  63. <programlisting><link linkend="gboolean">gboolean</link>    gimp_display_delete             (<link linkend="gint32">gint32</link> display_ID);</programlisting>
  64. <para>
  65. Delete the specified display.
  66. </para>
  67. <para>
  68. This procedure removes the specified display. If this is the last
  69. remaining display for the underlying image, then the image is
  70. deleted also.</para>
  71. <para>
  72.  
  73. </para><informaltable pgwide=1 frame="none" role="params">
  74. <tgroup cols="2">
  75. <colspec colwidth="2*">
  76. <colspec colwidth="8*">
  77. <tbody>
  78. <row><entry align="right"><parameter>display_ID</parameter> :</entry>
  79. <entry> The display to delete.
  80. </entry></row>
  81. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  82. </entry></row>
  83. </tbody></tgroup></informaltable></refsect2>
  84. <refsect2>
  85. <title><anchor id="gimp-displays-flush">gimp_displays_flush ()</title>
  86. <programlisting><link linkend="gboolean">gboolean</link>    gimp_displays_flush             (void);</programlisting>
  87. <para>
  88. Flush all internal changes to the user interface
  89. </para>
  90. <para>
  91. This procedure takes no arguments and returns nothing except a
  92. success status. Its purpose is to flush all pending updates of image
  93. manipulations to the user interface. It should be called whenever
  94. appropriate.</para>
  95. <para>
  96.  
  97. </para><informaltable pgwide=1 frame="none" role="params">
  98. <tgroup cols="2">
  99. <colspec colwidth="2*">
  100. <colspec colwidth="8*">
  101. <tbody>
  102. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  103. </entry></row>
  104. </tbody></tgroup></informaltable></refsect2>
  105.  
  106. </refsect1>
  107.  
  108.  
  109.  
  110.  
  111. </refentry>
  112.